Feature: Jellystat widget #5185

Zlendy · 2025-04-17T16:03:46Z

Proposed change

Implements #1333

This widget shows the playback count from user-specified libraries in the last n days.
It uses the API endpoint http://jellystat.host.or.ip/stats/getViewsByLibraryType implemented in v1.1.16

Type of change

New service widget
Bug fix (non-breaking change which fixes an issue)
New feature or enhancement (non-breaking change which adds functionality)
Documentation only
Other (please explain)

Checklist:

If applicable, I have added corresponding documentation changes.
If applicable, I have reviewed the feature / enhancement and / or service widget guidelines.
I have checked that all code style checks pass using pre-commit hooks and linting checks.
If applicable, I have tested my code for new features & regressions on both mobile & desktop devices, using the latest version of major browsers.

Jellystat

Usage

Generate an API key (http://jellystat.host.or.ip/settings)

Add this to services.yaml

- Dev:
    - Jellystat:
        href: http://jellystat.host.or.ip
        widget:
          type: jellystat
          url: http://jellystat.host.or.ip
          key: apikeyapikeyapikeyapikeyapikeyapikeyapikeyapikeyapikeyapikey
          fields: ["songs", "movies", "episodes", "other"]
          days: 30

Screenshots

Zlendy · 2025-04-17T16:07:01Z

I have not added any documentation yet because there's a few things I'd like to discuss with a maintainer first.

Zlendy · 2025-04-17T16:10:57Z

I have not used widget.fields and instead created a different YAML field widget.libraries, this is not a design decision but a limitation caused by this code:

homepage/src/components/services/widget/container.jsx

Lines 34 to 52 in 0a1bf3b

    
           visibleChildren = childrenArray?.filter((child) => 
        
             fields.some((field) => { 
        
               let fullField = field; 
        
               if (!field.includes(".")) { 
        
                 fullField = `${type}.${field}`; 
        
               } 
        
               let matches = fullField === child?.props?.label; 
        
               // check if the field is an 'alias' 
        
               if (matches) { 
        
                 return true; 
        
               } else if (ALIASED_WIDGETS[type]) { 
        
                 matches = fullField.replace(type, ALIASED_WIDGETS[type]) === child?.props?.label; 
        
                 return matches; 
        
               } 
        
               // no match 
        
               return false; 
        
             }), 
        
           );

Is this acceptable or should I look into a way of using widget.fields like every other widget does?

shamoon

See comment about post.
And yes in general this needs to conform with other widgets, using fields etc. how you’ve coded this will break things like translations etc

src/widgets/jellystat/component.jsx

Zlendy · 2025-04-17T18:24:31Z

how you’ve coded this will break things like translations

You can't translate the name of the library, that's part of the problem.

shamoon · 2025-04-17T18:40:17Z

how you’ve coded this will break things like translations

You can't translate the name of the library, that's part of the problem.

Ah, ok I kinda get what you mean here, the blocks are determined by the users install. I havent looked in detail yet but what other similar services do is to provide data that is more generic i.e. total up the # of videos / songs / whatever (I dont even know what jellystat is for yet, again havent looked)

Zlendy · 2025-04-17T18:47:00Z

how you’ve coded this will break things like translations

You can't translate the name of the library, that's part of the problem.

Ah, ok I kinda get what you mean here, the blocks are determined by the users install. I havent looked in detail yet but what other similar services do is to provide data that is more generic i.e. total up the # of videos / songs / whatever (I dont even know what jellystat is for yet, again havent looked)

Jellystat is Jellyfin's version of Tautulli. It provides statistics for many aspects of a Jellyfin server, one of which being user playback count.
I also thought of displaying data in a more generic way as you suggested here but ended up doing this instead to avoid making 2 API calls AND being forced to do this weird proxy/POST thing.

Nothing is stopping me from contributing first a new endpoint to Jellystat and use that here, but there's no guarantee that it will be merged (or when).

shamoon · 2025-04-17T18:50:54Z

Nothing is stopping me from contributing first a new endpoint to Jellystat and use that here, but there's no guarantee that it will be merged (or when).

Thats of course your call. I agree it could be nicer / easier to have some kind of overall 'stats' endpoint (many many projects do something like this) but yea I dont know how active / open that project is.

Zlendy · 2025-04-19T19:55:03Z

CyferShepard/Jellystat#378
With that PR merged, I can refactor this widget into something less janky.

Zlendy · 2025-04-20T13:03:38Z

Ok, refactoring done. This is now using an endpoint which is currently only on the unstable branch of Jellystat.

I suppose it would be a good idea to wait until it gets released in a stable version before this PR gets merged.

This new code is good enough imo. Should I start working on the documentation?

services.yml

- Dev:
    - Jellystat:
        href: http://jellystat.host.or.ip
        widget:
          type: jellystat
          url: http://jellystat.host.or.ip
          key: apikeyapikeyapikeyapikeyapikeyapikeyapikeyapikeyapikeyapikey
          fields: ["songs", "movies", "episodes", "other"]

New screenshots

Jellystat API	Homepage

shamoon · 2025-04-20T19:41:56Z

This is great and yea the code is much cleaner! I guess the only thing is as you said, we should at least wait until the API endpoint is released (and we'll be able to note the min required version in the docs). If it's going to be a few weeks might be better to close this and re-open when ready. Thanks again for the effort on both ends

AdamWHY2K · 2025-04-21T20:46:18Z

just curious if this widget should also support streamystats or if that should be it's own fr?

Zlendy · 2025-04-21T20:49:35Z

That's a completely different service, unless it has a 100% identical API endpoint (which is extremely unlikely) it's not supported.

AdamWHY2K · 2025-04-21T20:53:27Z

That's a completely different service, unless it has a 100% identical API endpoint (which is extremely unlikely) it's not supported.

just checked the API, doesn't look like it does. I'll make a separate fr for it :)

shamoon · 2025-04-21T21:23:17Z

@Zlendy just holler when they release your change, this can probably be reopened if it’s not too long from now. Thanks again.

Zlendy · 2025-05-01T18:00:31Z

@shamoon The required endpoint landed in the new jellystat release
https://github.com/CyferShepard/Jellystat/releases/tag/1.1.6

Please reopen this PR so that I can continue working on this feature

Zlendy · 2025-05-02T08:18:36Z

I have rebased this branch to dev, added documentation and made a couple of small tweaks to the widget.
This is ready for review now.

shamoon

Nice, much cleaner. Tiny stuff here

src/widgets/jellystat/component.jsx

shamoon · 2025-05-03T02:05:27Z

src/utils/config/service-helpers.js

should be inserted alphabetical (ish) by widget name

I tried to apply this suggestion, but honestly there are far too many widgets in the wrong order to be sure this is what you meant.

833db71b8770678c3c3efffe62286bef034c632e

Co-authored-by: shamoon <[email protected]>

…t name

src/widgets/jellystat/component.jsx

shamoon

Great thanks

pippo73 · 2025-05-29T21:02:05Z

Sorry, but I'm running the version 1.2.0 but I cannot find this widget. Will it be released in a future version?

shamoon · 2025-05-29T22:20:33Z

Yes. Or you can run dev.

pippo73 · 2025-05-30T16:50:29Z

Yes. Or you can run dev.

Sorry what do you mean with "run dev" ? could you explain me pls :-)

shamoon · 2025-05-30T17:01:08Z

Change the docker image tag to dev

github-actions · 2025-06-30T03:33:24Z

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new discussion for related concerns. See our contributing guidelines for more details.

shamoon requested changes Apr 17, 2025

View reviewed changes

src/widgets/jellystat/component.jsx Outdated Show resolved Hide resolved

Zlendy requested a review from shamoon April 20, 2025 17:54

shamoon closed this Apr 21, 2025

shamoon reopened this May 1, 2025

Zlendy force-pushed the feat/jellystat branch 2 times, most recently from 6b7fa49 to a3c351d Compare May 2, 2025 08:14

Zlendy marked this pull request as ready for review May 2, 2025 08:19

Zlendy force-pushed the feat/jellystat branch 2 times, most recently from 380d782 to 1b4391c Compare May 2, 2025 11:44

shamoon requested changes May 3, 2025

View reviewed changes

Zlendy and others added 5 commits May 3, 2025 13:05

Feature: Jellystat widget

da9a423

Feature: Add "days" parameter to Jellystat widget

4791561

Enhancement: Improve error detection in Jellystat widget

13518f5

Docs: Jellystat widget

08a95de

Refactor: Remove unnecessary fields length check

8b7aef1

Co-authored-by: shamoon <[email protected]>

Refactor: Insert "days" variable in alphabetical (ish) order by widge…

5c1b480

…t name

Zlendy force-pushed the feat/jellystat branch from 833db71 to 5c1b480 Compare May 3, 2025 11:06

shamoon reviewed May 3, 2025

View reviewed changes

src/widgets/jellystat/component.jsx Outdated Show resolved Hide resolved

Fix

e32c904

shamoon enabled auto-merge (squash) May 3, 2025 15:26

shamoon approved these changes May 3, 2025

View reviewed changes

shamoon merged commit 7e87522 into gethomepage:dev May 3, 2025
5 checks passed

github-actions bot locked as resolved and limited conversation to collaborators Jun 30, 2025

Zlendy deleted the feat/jellystat branch June 30, 2025 19:06

Uh oh!

Feature: Jellystat widget #5185

Feature: Jellystat widget #5185

Uh oh!

Conversation

Zlendy commented Apr 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed change

Type of change

Checklist:

Jellystat

Usage

Screenshots

Uh oh!

Zlendy commented Apr 17, 2025

Uh oh!

Zlendy commented Apr 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

shamoon left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Zlendy commented Apr 17, 2025

Uh oh!

shamoon commented Apr 17, 2025

Uh oh!

Zlendy commented Apr 17, 2025

Uh oh!

shamoon commented Apr 17, 2025

Uh oh!

Zlendy commented Apr 19, 2025

Uh oh!

Zlendy commented Apr 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

shamoon commented Apr 20, 2025

Uh oh!

AdamWHY2K commented Apr 21, 2025

Uh oh!

Zlendy commented Apr 21, 2025

Uh oh!

AdamWHY2K commented Apr 21, 2025

Uh oh!

shamoon commented Apr 21, 2025

Uh oh!

Zlendy commented May 1, 2025

Uh oh!

Zlendy commented May 2, 2025

Uh oh!

shamoon left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

shamoon May 3, 2025

Choose a reason for hiding this comment

Uh oh!

Zlendy May 3, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

shamoon left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

pippo73 commented May 29, 2025

Uh oh!

shamoon commented May 29, 2025

Uh oh!

pippo73 commented May 30, 2025

Uh oh!

shamoon commented May 30, 2025

Uh oh!

github-actions bot commented Jun 30, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Zlendy commented Apr 17, 2025 •

edited

Loading

Zlendy commented Apr 17, 2025 •

edited

Loading

Zlendy commented Apr 20, 2025 •

edited

Loading